home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / iconupdate / iconupdate.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  9KB  |  200 lines
  1. @database "IconUpdate Documentation"
  2. @author "Gerri K
  3. rner"
  4. @(c) "Copyright 
  5.  1994 Gerri K
  6. rner"
  7. @$VER: IconUpdate Documentation 4.05 (5-May-94)
  8. @node main "Welcome to IconUpdate"
  9.                               IconUpdate 2/4
  10.                               ==============
  11.                  Copyright 
  12.  March 1994, by Gerri K
  13. rner 
  14.                          - Freely distributable -
  15.             if you like this program, please send me an e-mail
  16.                           This application uses
  17.                         MUI - MagicUserInterface
  18.                   (c) Copyright 1993 by Stefan Stuntz
  19.                            1.@{" INTRODUCTION  " link intro}
  20.                            2.@{" USAGE via CLI " link useCLI}
  21.                            3.@{" USAGE via WB  " link useWB}
  22.                            4.@{"    CREDITS    " link credits}
  23.                            5.@{"    AUTHOR     " link author}
  24.                            6.@{" DISTRIBUTION  " link distri}
  25.                            7.@{"    HISTORY    " link history}
  26.                            8.@{"      MUI      " link MUI}
  27. @endnode
  28. @node intro
  29.   1. INTRODUCTION
  30.   ---------------
  31.   When copying an icon over another with the simple 'copy' command, the
  32.   destination icon will be completely replaced by the source icon. No
  33.   information will be preserved. That's the reason why we equipped MagicWB
  34.   with this versatile and easy-to-use command.
  35.   IconUpdate provides you with a very comfortable way of only copying the
  36.   images of one icon to another while preserving the information of the
  37.   original icon. This information can be the STACK size, the TOOLTYPES, the
  38.   DEFAULT TOOL, the original ICON POSITION and the original WINDOW POSITION
  39.   of icon-types like Trashcan, Disk and Drawer.
  40.   With this command you won't need IconEdit anymore for tasks like converting
  41.   an old icon to a new MagicWB-Icon. It will be faster by using this command
  42.   and you won't have problems with bugs in IconEdit (like the IconEdit3.0
  43.   bug, when loading 'both images' from an icon and saving it, IconEdit saves
  44.   the whole icon area, giving the icon the maximum border on the WB though
  45.   the icon image may be much smaller).
  46.   As this version of IconUpdate is not tied to MagicWB anymore, you can use it
  47.   for your own projects as well. See @{" DISTRIBUTION " link distri} for details.
  48.   Kickstart 2.x or higher required !!
  49. @endnode
  50. @node useCLI "Usage"
  51.   2. USAGE via CLI
  52.   ----------------
  53.   The command line for IconUpdate201 is:
  54.            ICONUPDATE <T|C|S|D|W> <FROM[.info]> <TO[.info]>
  55.   The flags mean:
  56.   <T> = Preserve TOOLTYPES of original icon
  57.   <C> = Preserve SNAPSHOT POSITION of original icon
  58.   <S> = Preserve STACK SIZE number of original icon
  59.   <D> = Preserve DEFAULT TOOL entry of original icon
  60.   <W> = Preserve WINDOW POSITION of original icon (drawer, disk, trashcan)
  61.   You may just use one flag or all flags, just at will. The order is also
  62.   not important, which means you can mix the flags.
  63.   These two arguments are obligatory:
  64.   <FROM[.info]> = new Icon  (you may or may not use the .info extension)
  65.   <TO[.info]>   = old Icon  (use of .info extension as you like)
  66.   Feature: IconUpdate201 is PURE. So you can make it RESIDENT.
  67.   The MUI version IconUpdate405 does not support any commandline arguments. 
  68.                              @{" Example " link example}
  69. @endnode
  70. @node Example
  71.   Example:
  72.   --------
  73.               IconUpdate ctd NewIcon.info OldIcon.info
  74.   This will copy the new icon image over the image of the old icon,
  75.   preserving the position, the tooltypes and the default tool entry of the
  76.   old icon. The stack size and the window position (only necessary if the
  77.   destination icon is either a drawer, disk or trashcan icon) will not be
  78.   preserved because the S- and W-Flag were not set. Thus the stack and
  79.   window position information of the old icon will be replaced by those of
  80.   the source (new) icon.
  81.   I think it should be rather clear now how to use this command.
  82. @endnode
  83. @node useWB "Usage"
  84.   3. USAGE via WB
  85.   ---------------
  86.   You activate IconUpdate via the Workbench by clicking onto its icon
  87.   'IconUpdate40'. Read the section @{" USAGE via CLI " link useCLI} and you
  88.   should be familiar with the possibilities presented by the GUI.
  89.   There are two ways to enter the Source/Target name:
  90.               - using the string gadget (they are coupled by the TAB key);
  91.         you don't need to type the full name anymore, ".info" is added
  92.                 automatically
  93.               - by clicking on the disk gadget, which opens a requester
  94.               - dropping an icon on the string-gadgets
  95.   The preserve flags can be set/unset by clicking on the checkmark next to
  96.   them.
  97.   Click on the start button to invoke the update process.
  98.   Its really easy to use, isn
  99. t it ?
  100.   HINT:
  101.   - If you use the SOURCE and TARGET requester, it is not opened in the same directory.
  102.     This should it make easier to update multiple Icons in different drawers. 
  103.   - All functions can be accessed by clicking on it as well as using the shortcuts
  104. @endnode
  105. @node credits "Credits"
  106.   4. CREDITS
  107.   ----------
  108.   Martin Huttenloher ( initiator, comments, bug reports, MagicWB )
  109.   Martin Kornd
  110. rfer ( additional programming help )
  111. rgen & Markus Matern ( beta testers, suggestions )
  112.   Stefan Stuntz ( @{" MUI " link MUI } )
  113.   I strongly suggest you to get the registered version for the real MUI-feeling !! 
  114.   Read the ReadMe.mui file for further information
  115.   Matt Dillon ( DICE )
  116. @endnode
  117. @node author "Author"
  118.   5. AUTHOR
  119.   ----------
  120.   If you have any bug reports, comments, suggestions or if you want
  121.   to include IconUpdate in your own package, here is my adress:
  122.   E-Mail:     s_koerner@rzmain.rz.uni-ulm.de
  123.           or
  124.               gerri.koerner@student.rz.uni-ulm.de
  125.   Snail-Mail: Gerri K
  126.               Kulturenweg 6
  127.               87642 Buching
  128.              
  129.               Germany
  130. @endnode
  131. @node distri "Distribution"
  132.   6. DISTRIBUTION / WARRANTY
  133.   --------------------------
  134.   IconUpdate 2/4 is freely redistributable as far as all files in this 
  135.   package are kept together.
  136.   If you want to include IconUpdate in your own package, you must send me a 
  137.   short note.
  138.   I can and will not be held responsible for any damages which are caused
  139.   directly or indirectly by IconUpdate. Use at your own risk ! 
  140. @endnode
  141. @node history "History"
  142.   7. HISTORY
  143.   ----------
  144.   v1.0 written 16-Sep-93 by Gerri K
  145.   v1.1 written 17-Sep-93:
  146.       - with or without .info extension possible
  147.   v1.2 written 18-Sep-93:
  148.       - cosmetic changes
  149.   v1.3 written 20-Sep-93:
  150.       - W flag added
  151.   v1.4 written 21-Sep-93: 
  152.       - rearranged code ( THANK YOU MaKo for your invaluable help )
  153.       - up to 200 tooltypes can be processed now
  154.   separated development from Martin Huttenloher 
  155.   v2.0 written 23-Sep-93:      
  156.       
  157.       - IU analyses if the signature already exists: If so, it won't
  158.         add another signature to the tooltype entries, thus avoiding
  159.         multiple signatures in one icon (and saving space)
  160.       - cosmetic changes
  161.    v2.1 written 24-Sep-93:    
  162.       - WB/FileReq support
  163.       - Requester Mode added
  164.    v2.2 written 29-Sep-93:    
  165.       - splitted into several Modules
  166.       - added / to current_dir (bug removed)
  167.    v3.0 written 29-Sep-93:    
  168.       - GUI added
  169.       - Dice only
  170.    v4.0 written 23-Feb-94:
  171.      
  172.       - MUI version
  173.       - fixed some icon_type misuse bugs
  174.    v4.05 written 25-Mar-94:
  175.       - drop objects added
  176.       - ".info" completion added
  177. @endnode
  178. @node MUI "MUI"
  179.   8.MUI - MagicUserInterface
  180.   --------------------------
  181.                             This application uses
  182.                           MUI - MagicUserInterface
  183.                     (c) Copyright 1993 by Stefan Stuntz
  184.   MUI is a system to generate and maintain graphical user interfaces. With
  185.   the  aid  of  a  preferences program, the user of an application has the
  186.   ability to customize the outfit according to his personal taste.
  187.   MUI is distributed as shareware. To obtain a complete package containing
  188.   lots of examples and more information about registration please look for
  189.   a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
  190.   your local bulletin boards or on public domain disks.
  191.             If you want to register directly, feel free to send
  192.                            DM 20.-  or  US$ 15.-
  193.                                     to
  194.                                Stefan Stuntz
  195.                           Eduard-Spranger-Stra
  196.                                80935 M
  197. nchen
  198.                                   GERMANY
  199. @endnode
  200.